/*=============================================================================

  Library: CFS

  Copyright (c) German Cancer Research Center,
    Division of Medical and Biological Informatics

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=============================================================================*/

#ifndef CFSLOCATIONMANAGER_H
#define CFSLOCATIONMANAGER_H

#include <QString>

class CFSBasicLocation;

/**
 * This class is used to manage the various Locations for BlueBerry.
 * <p>
 * Clients may not extend this class.
 * </p>
 * @noextend This class is not intended to be subclassed by clients.
 */
class CFSLocationManager
{

public:

  static const QString READ_ONLY_AREA_SUFFIX; // = ".readOnly";

  // configuration area file/dir names
  static const QString CONFIG_FILE; // = "config.ini";
  static const QString CFS_PROPERTIES; // = "CFS.properties";

  /**
   * Initializes the QFileInfo objects for the CFSLocationManager.
   */
  static void initializeLocations();

  /**
   * Returns the user CFSLocation object
   * @return the user CFSLocation object
   */
  static CFSBasicLocation* getUserLocation();

  /**
   * Returns the configuration CFSLocation object
   * @return the configuration CFSLocation object
   */
  static CFSBasicLocation* getConfigurationLocation();

  /**
   * Returns the install CFSLocation object
   * @return the install CFSLocation object
   */
  static CFSBasicLocation* getInstallLocation();

  /**
   * Returns the instance CFSLocation object
   * @return the instance CFSLocation object
   */
  static CFSBasicLocation* getInstanceLocation();

  static CFSBasicLocation* getCFSHomeLocation();

};

#endif // CFSLOCATIONMANAGER_H
